import {BGMapHereMaps} from 'gisplay-es6-webpack/src/Gisplay/Maps/Background Maps/BGMapHereMaps.js'Constructor Summary
| Public Constructor | ||
| public |
constructor(bgmap: Object) Creates an instance of Here Maps. |
|
Method Summary
| Public Methods | ||
| public |
addClickEvent(map: Map) Add click event. |
|
| public |
addEventListener(eventstr: string, eventfunction: Function): void Adds a listener to a specified event type. |
|
| public |
addPanEvent(fun: Function) Add Pan/Drag event. |
|
| public |
addZoomEvent(fun: Function) Add zoom event. |
|
| public |
createCanvas(id: number): HTMLElement Given one id it creates a canvas object. |
|
| public |
Returns the latitude(Y) of the bounding box northwest corner. |
|
| public |
Returns the longitude(X) of the bounding box northwest corner. |
|
| public |
getContainer(): HTMLElement Returns the map's containing HTML element. |
|
| public |
Returns the map's current zoom level. |
|
Inherited Summary
| From class BGMapWrapper | ||
| public |
This is the background map object that comes from the background map provider(e.g., MapBox). |
|
| public |
loaderDiv: HTMLDivElement The div that contains the loader. |
|
| public |
addClickEvent(map: Map) Add click event. |
|
| public |
addEventListener(eventstr: string, eventfunction: Function): void Adds a listener to a specified event type. |
|
| public |
addPanEvent(fun: Function) Add Pan/Drag event. |
|
| public |
addZoomEvent(fun: Function) Add zoom event. |
|
| public |
createCanvas(id: number): HTMLElement Given one id it creates a canvas object. |
|
| public |
createLoader(): void Auxiliar method to be called when there is no loader and we want to create one. |
|
| public |
Returns the background map object. |
|
| public |
Returns the latitude of the bounding box northwest corner. |
|
| public |
Returns the longitude of the bounding box northwest corner. |
|
| public |
getContainer(): HTMLElement Returns the map's containing HTML element. |
|
| public |
Returns the height of the canvas element. |
|
| public |
Returns the width of the canvas elment. |
|
| public |
Returns the map's current zoom level. |
|
| public |
showLoader(): void Shows loader at the beginning when the API is loading the data. |
|
Public Constructors
public constructor(bgmap: Object) source
Creates an instance of Here Maps.
Override:
BGMapWrapper#constructorParams:
| Name | Type | Attribute | Description |
| bgmap | Object | The Here Maps object. |
Public Methods
public addClickEvent(map: Map) source
Add click event.
Override:
BGMapWrapper#addClickEventParams:
| Name | Type | Attribute | Description |
| map | Map | The function to be called when the user clicks on the map. |
public addEventListener(eventstr: string, eventfunction: Function): void source
Adds a listener to a specified event type.
Override:
BGMapWrapper#addEventListenerReturn:
| void |
public addPanEvent(fun: Function) source
Add Pan/Drag event.
Override:
BGMapWrapper#addPanEventParams:
| Name | Type | Attribute | Description |
| fun | Function | The function to be called when the user performs drag on the map. |
public addZoomEvent(fun: Function) source
Add zoom event.
Override:
BGMapWrapper#addZoomEventParams:
| Name | Type | Attribute | Description |
| fun | Function | The function to be called when the user performs zoom in/out on the map. |
public createCanvas(id: number): HTMLElement source
Given one id it creates a canvas object.
Override:
BGMapWrapper#createCanvasParams:
| Name | Type | Attribute | Description |
| id | number | The id of the canvas to be created. |
Return:
| HTMLElement | Canvas object where everything will be drawn. |
TODO:
- Understand case mapbox comment bellow.
public getCenterLat(): number source
Returns the latitude(Y) of the bounding box northwest corner.
Override:
BGMapWrapper#getCenterLatpublic getCenterLng(): number source
Returns the longitude(X) of the bounding box northwest corner.
Override:
BGMapWrapper#getCenterLngpublic getContainer(): HTMLElement source
Returns the map's containing HTML element.
Override:
BGMapWrapper#getContainerReturn:
| HTMLElement | The map's HTML element container. |